<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>kalman-cpp: kalman/fx.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">kalman-cpp
   </div>
   <div id="projectbrief">Implementation of Kalman Filter in C++</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('fx_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">fx.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="fx_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#ifndef FX_H</span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#define FX_H</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="fx_8h.html#a525335710b53cb064ca56b936120431e">   30</a></span>&#160;<span class="preprocessor">#define _USE_MATH_DEFINES</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#include &lt;math.h&gt;</span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#include &lt;assert.h&gt;</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#include &lt;armadillo&gt;</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="keyword">using namespace </span>std;</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="keyword">using namespace </span>arma;</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160; </div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="class_f_x.html">   39</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_f_x.html">FX</a></div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;{</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    <a class="code" href="class_f_x.html#a55c1146952f7c792e9d0b73603427093">FX</a>(colvec(*f) (colvec &amp;x, colvec &amp;some_constants));</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    </div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    <a class="code" href="class_f_x.html#adcbe426b544509f4e3d1b174d3a87c1e">~FX</a>();</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    mat <a class="code" href="class_f_x.html#a99f9d802876f6726360ff8dd97349bab">JacobianAt</a>(colvec &amp;x, colvec &amp;some_constants);</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;    </div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    mat <a class="code" href="class_f_x.html#a54e5d98adac66b1f8e7fb7217b056ec9">HessianAt</a>(colvec &amp;x, colvec &amp;some_constants, <span class="keywordtype">int</span> i);</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;     </div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    colvec <a class="code" href="class_f_x.html#ac1ef2f0229463d1a9d12ee2041972e12">SolveAt</a>(colvec &amp;x, colvec &amp;some_constants);</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160; </div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="class_f_x.html#af5dac6379cad0385dd26219bc9d184d7">SetEpsilon</a>(<span class="keywordtype">double</span> epsilon);</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160; </div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="keyword">private</span>: </div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    colvec (*F_) (colvec &amp;x, colvec &amp;some_constants); </div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160; </div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;    <span class="keywordtype">double</span> Epsilon_; </div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;};</div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160; </div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclass_f_x_html"><div class="ttname"><a href="class_f_x.html">FX</a></div><div class="ttdef"><b>Definition:</b> fx.h:40</div></div>
<div class="ttc" id="aclass_f_x_html_a54e5d98adac66b1f8e7fb7217b056ec9"><div class="ttname"><a href="class_f_x.html#a54e5d98adac66b1f8e7fb7217b056ec9">FX::HessianAt</a></div><div class="ttdeci">mat HessianAt(colvec &amp;x, colvec &amp;some_constants, int i)</div><div class="ttdoc">Calculate the Hessian, at certain inputs.</div><div class="ttdef"><b>Definition:</b> fx.cpp:53</div></div>
<div class="ttc" id="aclass_f_x_html_a55c1146952f7c792e9d0b73603427093"><div class="ttname"><a href="class_f_x.html#a55c1146952f7c792e9d0b73603427093">FX::FX</a></div><div class="ttdeci">FX(colvec(*f)(colvec &amp;x, colvec &amp;some_constants))</div><div class="ttdoc">Constructor, create a mathematical function.</div><div class="ttdef"><b>Definition:</b> fx.cpp:10</div></div>
<div class="ttc" id="aclass_f_x_html_a99f9d802876f6726360ff8dd97349bab"><div class="ttname"><a href="class_f_x.html#a99f9d802876f6726360ff8dd97349bab">FX::JacobianAt</a></div><div class="ttdeci">mat JacobianAt(colvec &amp;x, colvec &amp;some_constants)</div><div class="ttdoc">Calculate the Jacobian at certain inputs.</div><div class="ttdef"><b>Definition:</b> fx.cpp:29</div></div>
<div class="ttc" id="aclass_f_x_html_ac1ef2f0229463d1a9d12ee2041972e12"><div class="ttname"><a href="class_f_x.html#ac1ef2f0229463d1a9d12ee2041972e12">FX::SolveAt</a></div><div class="ttdeci">colvec SolveAt(colvec &amp;x, colvec &amp;some_constants)</div><div class="ttdoc">Solve the function at certain inputs.</div><div class="ttdef"><b>Definition:</b> fx.cpp:23</div></div>
<div class="ttc" id="aclass_f_x_html_adcbe426b544509f4e3d1b174d3a87c1e"><div class="ttname"><a href="class_f_x.html#adcbe426b544509f4e3d1b174d3a87c1e">FX::~FX</a></div><div class="ttdeci">~FX()</div><div class="ttdoc">Destructor, nothing happens here.</div><div class="ttdef"><b>Definition:</b> fx.cpp:19</div></div>
<div class="ttc" id="aclass_f_x_html_af5dac6379cad0385dd26219bc9d184d7"><div class="ttname"><a href="class_f_x.html#af5dac6379cad0385dd26219bc9d184d7">FX::SetEpsilon</a></div><div class="ttdeci">void SetEpsilon(double epsilon)</div><div class="ttdoc">A very small number.</div><div class="ttdef"><b>Definition:</b> fx.cpp:77</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_dc133b73f91f0e3b4287924ed00a2a00.html">kalman</a></li><li class="navelem"><a class="el" href="fx_8h.html">fx.h</a></li>
    <li class="footer">Generated on Thu Apr 1 2021 04:15:37 for kalman-cpp by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2 </li>
  </ul>
</div>
</body>
</html>
